home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / grafik / amiwin / x11 / man / xauth.man < prev    next >
Encoding:
Text File  |  1996-07-16  |  8.5 KB  |  265 lines
  1.  
  2.  
  3.  
  4. XAUTH(1)                 USER COMMANDS                   XAUTH(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      xauth - X authority file utility
  10.  
  11. SYNOPSIS
  12.      xauth [ -f authfile ] [ -vqib ] [ command arg ... ]
  13.  
  14. DESCRIPTION
  15.      The xauth program is used to edit and display the authoriza-
  16.      tion  information  used in connecting to the X server.  This
  17.      program is usually used  to  extract  authorization  records
  18.      from  one  machine  and  merge them in on another (as is the
  19.      case when using remote logins or granting  access  to  other
  20.      users).   Commands (described below) may be entered interac-
  21.      tively, on the xauth command line, or in scripts.  Note that
  22.      this  program does not contact the X server.  Normally xauth
  23.      is not used to create the authority file entry in the  first
  24.      place; xdm does that.
  25.  
  26. OPTIONS
  27.      The following options may be used with xauth.  They  may  be
  28.      given  individually  (e.g.,  -q  -i)  or may combined (e.g.,
  29.      -qi).
  30.  
  31.      -f authfile
  32.              This option specifies the name of the authority file
  33.              to  use.  By default, xauth will use the file speci-
  34.              fied by the XAUTHORITY environment variable or .Xau-
  35.              thority in the user's home directory.
  36.  
  37.      -q      This option  indicates  that  xauth  should  operate
  38.              quietly  and  not print unsolicited status messages.
  39.              This is the default if an xauth command is is  given
  40.              on the command line or if the standard output is not
  41.              directed to a terminal.
  42.  
  43.      -v      This option indicates that xauth should operate ver-
  44.              bosely  and  print  status  messages  indicating the
  45.              results  of  various  operations  (e.g.,  how   many
  46.              records  have been read in or written out).  This is
  47.              the default if xauth is reading  commands  from  its
  48.              standard  input  and its standard output is directed
  49.              to a terminal.
  50.  
  51.      -i      This option indicates that xauth should  ignore  any
  52.              authority  file  locks.  Normally, xauth will refuse
  53.              to read or edit any authority files that  have  been
  54.              locked  by  other  programs  (usually xdm or another
  55.              xauth).
  56.  
  57.      -b      This option indicates that xauth should  attempt  to
  58.              break  any  authority  file locks before proceeding.
  59.              Use this option only to clean up stale locks.
  60.  
  61.  
  62.  
  63. X Version 11         Last change: Release 6                     1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XAUTH(1)                 USER COMMANDS                   XAUTH(1)
  71.  
  72.  
  73.  
  74. COMMANDS
  75.      The following commands may be used to  manipulate  authority
  76.      files:
  77.  
  78.      add displayname protocolname hexkey
  79.              An authorization entry  for  the  indicated  display
  80.              using  the  given  protocol and key data is added to
  81.              the authorization file.  The data is specified as an
  82.              even-lengthed  string  of  hexadecimal  digits, each
  83.              pair representing one octet.   The  first  digit  of
  84.              each  pair  gives the most significant 4 bits of the
  85.              octet, and the second digit of the  pair  gives  the
  86.              least significant 4 bits.  For example, a 32 charac-
  87.              ter hexkey would represent a 128-bit value.  A  pro-
  88.              tocol  name  consisting  of  just a single period is
  89.              treated as an abbreviation for MIT-MAGIC-COOKIE-1.
  90.  
  91.      [n]extract filename displayname...
  92.              Authorization entries  for  each  of  the  specified
  93.              displays  are written to the indicated file.  If the
  94.              nextract command is used, the entries are written in
  95.              a  numeric  format suitable for non-binary transmis-
  96.              sion  (such  as  secure   electronic   mail).    The
  97.              extracted  entries  can  be  read  back in using the
  98.              merge and nmerge commands.  If the filename consists
  99.              of  just  a single dash, the entries will be written
  100.              to the standard output.
  101.  
  102.      [n]list [displayname...]
  103.              Authorization entries  for  each  of  the  specified
  104.              displays  (or  all  if  no  displays  are named) are
  105.              printed on the standard output.  If the  nlist  com-
  106.              mand  is  used, entries will be shown in the numeric
  107.              format used by the nextract command; otherwise, they
  108.              are  shown  in a textual format.  Key data is always
  109.              displayed in the hexadecimal  format  given  in  the
  110.              description of the add command.
  111.  
  112.      [n]merge [filename...]
  113.              Authorization entries are read  from  the  specified
  114.              files  and  are  merged into the authorization data-
  115.              base, superceding any matching existing entries.  If
  116.              the nmerge command is used, the numeric format given
  117.              in the description of the extract command  is  used.
  118.              If  a  filename  consists of just a single dash, the
  119.              standard input will be read if it hasn't  been  read
  120.              before.
  121.  
  122.      remove displayname...
  123.              Authorization   entries   matching   the   specified
  124.              displays are removed from the authority file.
  125.  
  126.  
  127.  
  128.  
  129. X Version 11         Last change: Release 6                     2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XAUTH(1)                 USER COMMANDS                   XAUTH(1)
  137.  
  138.  
  139.  
  140.      source filename
  141.              The specified file is treated as a script containing
  142.              xauth  commands  to  execute.  Blank lines and lines
  143.              beginning with a sharp sign (#) are ignored.  A sin-
  144.              gle dash may be used to indicate the standard input,
  145.              if it hasn't already been read.
  146.  
  147.      info    Information  describing  the   authorization   file,
  148.              whether  or not any changes have been made, and from
  149.              where xauth commands are being read  is  printed  on
  150.              the standard output.
  151.  
  152.      exit    If any modifications have been made,  the  authority
  153.              file  is  written  out (if allowed), and the program
  154.              exits.  An end of file is  treated  as  an  implicit
  155.              exit command.
  156.  
  157.      quit    The program exits, ignoring any modifications.  This
  158.              may  also  be accomplished by pressing the interrupt
  159.              character.
  160.  
  161.      help [string]
  162.              A description of all commands that  begin  with  the
  163.              given string (or all commands if no string is given)
  164.              is printed on the standard output.
  165.  
  166.      ?       A short list of the valid commands is printed on the
  167.              standard output.
  168.  
  169. DISPLAY NAMES
  170.      Display names for the add,  [n]extract,  [n]list,  [n]merge,
  171.      and  remove  commands  use  the  same  format as the DISPLAY
  172.      environment variable and the common  -display  command  line
  173.      argument.   Display-specific information (such as the screen
  174.      number) is unnecessary and will  be  ignored.   Same-machine
  175.      connections  (such as local-host sockets, shared memory, and
  176.      the Internet Protocol hostname localhost) are referred to as
  177.      hostname/unix:displaynumber  so  that local entries for dif-
  178.      ferent machines may be stored in one authority file.
  179.  
  180. EXAMPLE
  181.      The most common use for xauth is to extract  the  entry  for
  182.      the  current  display, copy it to another machine, and merge
  183.      it into the user's authority file on the remote machine:
  184.  
  185.              %  xauth extract - $DISPLAY | rsh otherhost xauth merge -
  186.  
  187. ENVIRONMENT
  188.      This xauth program uses the following environment variables:
  189.  
  190.      XAUTHORITY
  191.              to get the name of the authority file to use if  the
  192.  
  193.  
  194.  
  195. X Version 11         Last change: Release 6                     3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XAUTH(1)                 USER COMMANDS                   XAUTH(1)
  203.  
  204.  
  205.  
  206.              -f option isn't used.
  207.  
  208.      HOME    to get the user's home directory if XAUTHORITY isn't
  209.              defined.
  210.  
  211. FILES
  212.      $HOME/.Xauthority
  213.              default authority file if XAUTHORITY isn't defined.
  214.  
  215. BUGS
  216.      Users that have unsecure networks should take  care  to  use
  217.      encrypted  file  transfer  mechanisms  to copy authorization
  218.      entries between machines. Similarly, the  MIT-MAGIC-COOKIE-1
  219.      protocol is not very useful in unsecure environments.  Sites
  220.      that are interested in additional security may need  to  use
  221.      encrypted authorization mechanisms such as Kerberos.
  222.  
  223.      Spaces are currently  not  allowed  in  the  protocol  name.
  224.      Quoting could be added for the truly perverse.
  225.  
  226. AUTHOR
  227.      Jim Fulton, MIT X Consortium
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261. X Version 11         Last change: Release 6                     4
  262.  
  263.  
  264.  
  265.